<html>
<head>
<style type='text/css'>
body {
   background-color: white;
   margin: 1em 2em 1em 2em;
   font-family: Sans-Serif;
   color: #002;
   line-height: 140%;
   font-size: 12px;
}

h1 {
    font-size: 140%;
}

h2 {
    font-size: 130%;
}

h3 {
    font-size: 120%;
}

h4 {
    font-size: 100%;
    font-style: normal;
    font-weight: bold;
}

h5 {
    font-size: 100%;
    font-style: italic;
    font-weight: normal;
}

pre {
   background-color: #eee;
   padding: 0.5em 0.5em 0.5em 2em;
}

@media print {
   pre {word-wrap:break-word; width:100%;}
} 

ul li,
ol li {
   padding-left: 0.3em;
   /*text-indent: -2em;*/
   margin-bottom: 0.5em;
}

em {
   font-style: normal;
   font-weight: bold;
   text-decoration: underline;
   color: #c40;
}

code {
   font-family: Monospace;
   font-size: 100%;
   color: #c40;
}

a, a * {
   text-decoration: underline;
   color: #14a0d1;
   /* border: 0.5px solid #aaa;
   white-space: nowrap;
   padding-right: 0.1em;
   padding-left: 0.1em;
   padding-bottom: -5px; */
}

a code {
   color: #14a0d1;
}

img {
   position: relative;
   bottom: -4px;
}

div.headline {
   font-weight: bold;
   font-size: 110%;
}

div.copyright {
   margin-top: 1em;
   border-top: 1px solid black;
   padding-top: 0.5em;
}

div.iris_headline {
   border-bottom: 1px solid black;
   padding-bottom: 0.3em;
}

.LaTeX {
   font-family: Monospace;
   font-size: 100%;
   border: 1px solid #060;
   color: #060;
}

code.LaTeX {
   background-color: white;
   padding: 0.5em 0.5em 0.5em 2em;
}
</style>
</head>

<body>
<div class="iris_headline">IRIS Toolbox Reference Manual</div>




<h2 id="model/neighbourhood">neighbourhood</h2>
<div class="headline">Evaluate the local behaviour of the objective function around the estimated parameter values</div>

<h4 id="syntax">Syntax</h4>
<pre><code>[D,FigH,AxH,ObjH,LikH,EstH,BH] = neighbourhood(M,PS,Neigh,...)</code></pre>
<h4 id="input-arguments">Input arguments</h4>
<ul>
<li><p><code>M</code> [ model | bkwmodel ] - Model or bkwmodel object.</p></li>
<li><p><code>PS</code> [ poster ] - Posterior simulator (poster) object returned by the <a href="../model/estimate.html"><code>model/estimate</code></a> function.</p></li>
<li><p><code>Neigh</code> [ numeric ] - The neighbourhood in which the objective function will be evaluated defined as multiples of the parameter estimates.</p></li>
</ul>
<h4 id="output-arguments">Output arguments</h4>
<ul>
<li><code>D</code> [ struct ] - Struct describing the local behaviour of the objective function and the data likelihood (minus log likelihood) within the specified range around the optimum for each parameter.</li>
</ul>
<p>The following output arguments are non-empty only if you choose <code>'plot='</code> true:</p>
<ul>
<li><p><code>FigH</code> [ numeric ] - Handles to the figures created.</p></li>
<li><p><code>AxH</code> [ numeric ] - Handles to the axes objects created.</p></li>
<li><p><code>ObjH</code> [ numeric ] - Handles to the objective function curves plotted.</p></li>
<li><p><code>LikH</code> [ numeric ] - Handles to the data likelihood curves plotted.</p></li>
<li><p><code>EstH</code> [ numeric ] - Handles to the actual estimate marks plotted.</p></li>
<li><p><code>BH</code> [ numeric ] - Handles to the bounds plotted.</p></li>
</ul>
<h4 id="options">Options</h4>
<ul>
<li><p><code>'plot='</code> [ <em><code>true</code></em> | <code>false</code> ] - Call the <a href="../grfun/plotneigh.html"><code>grfun.plotneigh</code></a> function from within <code>neighbourhood</code> to visualise the results.</p></li>
<li><p><code>'neighbourhood='</code> [ struct | <em>empty</em> ] - Struct specifying the neighbourhood points for some of the parameters; these points will be used instead of those based on <code>Neigh</code>.</p></li>
</ul>
<h4 id="plotting-options">Plotting options</h4>
<p>See help on <a href="../grfun/plotneigh.html"><code>grfun.plotneigh</code></a> for options available when you choose <code>'plot='</code> true.</p>
<h4 id="description">Description</h4>
<p>In the output database, <code>D</code>, each parameter is a 1-by-3 cell array. The first cell is a vector of parameter values at which the local behaviour was investigated. The second cell is a matrix with two column vectors: the values of the overall minimised objective function (as set up in the <a href="../model/estimate.html"><code>estimate</code></a> function), and the values of the data likelihood component. The third cell is a vector of four numbers: the parameter estimate, the value of the objective function at optimum, the lower bound and the upper bound.</p>
<h4 id="example">Example</h4>

</body>
<div class="copyright">IRIS Toolbox. Copyright &copy; 2007-2015 IRIS Solutions Team.</div>
</html>
